Skip to content

Commit

Permalink
Update device-roaming-status.yaml
Browse files Browse the repository at this point in the history
Aligned with device-reachability-status update.
  • Loading branch information
bigludo7 authored Jun 13, 2024
1 parent b1b96c5 commit b537f60
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions code/API_definitions/device-roaming-status.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
openapi: 3.0.3
info:
title: Device Roaming Status Retrieval
title: Device Roaming Status
description: |
This API provides the customer with the ability to query device:
- Roaming Status
This API provides the customer with the ability to query device roaming Status
# Introduction
Expand Down Expand Up @@ -36,7 +35,7 @@ info:
## Device roaming situation
The endpoint `POST /retrieve-roaming-status` allows to get roaming status and country information (if device in roaming situation) synchronously.
The endpoint `POST /retrieve` allows to get roaming status and country information (if device in roaming situation) synchronously.
## Further info and support
Expand All @@ -54,30 +53,30 @@ externalDocs:
url: https://github.com/camaraproject/

servers:
- url: "{apiRoot}/roaming-retrieval/v0"
- url: "{apiRoot}/device-roaming-status/v0"
variables:
apiRoot:
default: http://localhost:9091
description: API root

tags:
- name: Device roaming status
- name: Roaming status retrieval
description: Operation to get device roaming status and country information (if roaming) synchronously


paths:
/retrieve-roaming-status:
/retrieve:
post:
tags:
- Device roaming status
- Roaming status retrieval
summary: "Get the current roaming status and the country information"
description: Get the current roaming status and the country information
operationId: getRoamingStatus
parameters:
- $ref: '#/components/parameters/x-correlator'
security:
- openId:
- roaming-retrieval:read
- device-roaming-status:read
requestBody:
content:
application/json:
Expand Down Expand Up @@ -393,6 +392,11 @@ components:
status: 422
code: DEVICE_NOT_APPLICABLE
message: Service not applicable to the device
NetworkIssueToRetrieveRoamingStatus:
value:
status: 422
code: DEVICE_ROAMING_STATUS.UNABLE_TO_PROVIDE_ROAMING_STATUS
message: Network issue - Unable to provide roaming status
Generic500:
description: Server error
headers:
Expand Down

0 comments on commit b537f60

Please sign in to comment.