Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions code/API_definitions/dedicated-network-accesses.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ info:

which is needed to query the status of the Device Access (GET /accesses/{accessId}) and to delete Access (DELETE accesses/{accessId}).

## Error handling:

- If the dedicated network identified by the networkId is in an incompatible state when creating a device access, e.g. it is in the TERMINATED state, then the server will return an error with the `409 INCOMPATIBLE_STATE` error code.

# Querying one or more device accesses

All available device accesses of the API consumer can be queried by performing a `GET` operation on the `/accesses` endpoint. The query can be filted for accesses to a specific network (networkId) or for certain devices.
Expand Down Expand Up @@ -160,6 +164,8 @@ paths:
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"409":
$ref: "#/components/responses/Generic409"
"422":
$ref: "#/components/responses/Generic422"

Expand Down Expand Up @@ -529,6 +535,53 @@ components:
code: IDENTIFIER_NOT_FOUND
message: Device identifier not found.

Generic409:
description: Conflict
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 409
code:
enum:
- ABORTED
- ALREADY_EXISTS
- CONFLICT
- INCOMPATIBLE_STATE
examples:
GENERIC_409_ABORTED:
description: Concurreny of processes of the same nature/scope
value:
status: 409
code: ABORTED
message: Concurrency conflict.
GENERIC_409_ALREADY_EXISTS:
description: Trying to create an existing resource
value:
status: 409
code: ALREADY_EXISTS
message: The resource that a client tried to create already exists.
GENERIC_409_CONFLICT:
description: Duplication of an existing resource
value:
status: 409
code: CONFLICT
message: A specified resource duplicate entry found.
GENERIC_409_INCOMPATIBLE_STATE:
description: A resource referenced in the request is in an incompatible state for the requested operation
value:
status: 409
code: INCOMPATIBLE_STATE
message: A referenced resource is in an incompatible state.

Generic410:
description: Gone
headers:
Expand Down