Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing protocol-components for device-roaming-status-subscriptions #208

Merged
merged 2 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.6.0
version: wip
x-camara-commonalities: 0.4.0
externalDocs:
description: Product documentation at CAMARA
Expand Down
2 changes: 1 addition & 1 deletion code/API_definitions/device-reachability-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.6.0
version: wip
x-camara-commonalities: 0.4.0
externalDocs:
description: Product documentation at CAMARA
Expand Down
154 changes: 153 additions & 1 deletion code/API_definitions/device-roaming-status-subscriptions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.6.0
version: wip
x-camara-commonalities: 0.4.0
externalDocs:
description: Product documentation at CAMARA
Expand Down Expand Up @@ -919,6 +919,158 @@ components:
- MAX_EVENTS_REACHED
- ACCESS_TOKEN_EXPIRED

HTTPSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/HTTPSettings"

HTTPSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/HTTPSettings"

HTTPSettings:
type: object
properties:
headers:
type: object
description: |-
A set of key/value pairs that is copied into the HTTP request as custom headers.

NOTE: Use/Applicability of this concept has not been discussed in Commonalities under the scope of Meta Release v0.4. When required by an API project as an option to meet a UC/Requirement, please generate an issue for Commonalities discussion about it.
additionalProperties:
type: string
method:
type: string
description: The HTTP method to use for sending the message.
enum:
- POST

MQTTSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/MQTTSettings"

MQTTSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/MQTTSettings"

MQTTSettings:
type: object
properties:
topicName:
type: string
qos:
type: integer
format: int32
retain:
type: boolean
expiry:
type: integer
format: int32
userProperties:
type: object
required:
- topicName

AMQPSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/AMQPSettings"

AMQPSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/AMQPSettings"

AMQPSettings:
type: object
properties:
address:
type: string
linkName:
type: string
senderSettlementMode:
type: string
enum: ["settled", "unsettled"]
linkProperties:
type: object
additionalProperties:
type: string

ApacheKafkaSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/ApacheKafkaSettings"

ApacheKafkaSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/ApacheKafkaSettings"

ApacheKafkaSettings:
type: object
properties:
topicName:
type: string
partitionKeyExtractor:
type: string
clientId:
type: string
ackMode:
type: integer
required:
- topicName

NATSSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/NATSSettings"

NATSSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/NATSSettings"

NATSSettings:
type: object
properties:
subject:
type: string
required:
- subject

responses:
CreateSubscriptionBadRequest400:
description: Problem with the client request
Expand Down
2 changes: 1 addition & 1 deletion code/API_definitions/device-roaming-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.6.0
version: wip
x-camara-commonalities: 0.4.0
externalDocs:
description: Product documentation at CAMARA
Expand Down