Skip to content

Commit

Permalink
Update device-reachability-status.yaml
Browse files Browse the repository at this point in the history
Changed endpoint to /retrieve
Took suggestion on documentation
Device is not anymore mandatory
Add 422 for Network issue - Unable to provide reachability status

I think we're not on same page on the api name.
  • Loading branch information
bigludo7 authored Jun 13, 2024
1 parent c6677cd commit 6656937
Showing 1 changed file with 12 additions and 15 deletions.
27 changes: 12 additions & 15 deletions code/API_definitions/device-reachability-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ openapi: 3.0.3
info:
title: Device Reachability Status Retrieval
description: |
This API provides the customer with the ability to query device:
- Reachability status
This API provides the customer with the ability to query device reachability status (Data or SMS)
# Introduction
Expand All @@ -29,7 +28,7 @@ info:
## Device Reachability situation
The endpoint `POST /retrieve-reachability-status` allows to get current connectivity status information synchronously.
The endpoint `POST /retrieve` allows to get current reachability status information synchronously for a device.
## Further info and support
Expand All @@ -54,15 +53,15 @@ servers:
default: http://localhost:9091
description: API root
tags:
- name: Device reachability status
description: Operations to get the current reachability status of a device
- name: Reachability status retrieval
description: Retrieve the reachability status of a device
paths:
/retrieve-reachability-status:
/retrieve:
post:
tags:
- Device reachability status
- Reachability status retrieval
summary: "Get the current reachability status information"
description: Get the current reachability status information
description: Get the current reachability status information for a device.
operationId: getReachabilityStatus
parameters:
- $ref: '#/components/parameters/x-correlator'
Expand Down Expand Up @@ -239,8 +238,6 @@ components:
properties:
device:
$ref: "#/components/schemas/Device"
required:
- device

ErrorInfo:
type: object
Expand Down Expand Up @@ -321,11 +318,6 @@ components:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
NotFound:
value:
status: 404
code: NOT_FOUND
message: "The specified resource is not found"
DeviceIdentifierNotFound:
value:
status: 404
Expand Down Expand Up @@ -369,6 +361,11 @@ components:
status: 422
code: DEVICE_NOT_APPLICABLE
message: Service not applicable to the device
NetworkIssueToRetrieveReacabilityStatus:
value:
status: 422
code: DEVICE_REACHABILITY_STATUS.UNABLE_TO_PROVIDE_REACHABILITY_STATUS
message: Network issue - Unable to provide reachability status
Generic500:
description: Server error
headers:
Expand Down

0 comments on commit 6656937

Please sign in to comment.