Skip to content

Alignment of API definitions with Commonalities r3.3 #232

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.

Sign up for GitHub

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

Merged
bigludo7 merged 3 commits into from
Aug 25, 2025
Merged

Alignment of API definitions with Commonalities r3.3 #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7609d1
Reset YAML files back to wip
hdamker Aug 23, 2025
c6e01ee
align with commonalities
fernandopradocabrillo Aug 19, 2025
6b9579d
Revert ErrorInfo property order
hdamker Aug 23, 2025
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
27 changes: 16 additions & 11 deletions code/API_definitions/sim-swap-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,14 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.3.0-rc.1
version: wip
x-camara-commonalities: 0.6

externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/
servers:
- url: '{apiRoot}/sim-swap-subscriptions/v0.3-rc1'
- url: '{apiRoot}/sim-swap-subscriptions/vwip'
variables:
apiRoot:
default: http://localhost:9091
Expand Down Expand Up @@ -371,11 +371,10 @@ components:
description: HTTP response status code
code:
type: string
description: Code given to this error
description: A human-readable code to describe the error
message:
type: string
description: Detailed error description

description: A human-readable description of what the event represents
SubscriptionRequest:
description: The request for creating a sim swap event subscription
type: object
Expand Down Expand Up @@ -444,7 +443,7 @@ components:
type: string
format: date-time
example: 2025-01-17T13:18:23.682Z
description: The subscription expiration time (in date-time format) requested by the API consumer. Up to API project decision to keep it.
description: The subscription expiration time (in date-time format) requested by the API consumer. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Up to API project decision to keep it.
subscriptionMaxEvents:
type: integer
description: |
Expand Down Expand Up @@ -499,7 +498,11 @@ components:
accessTokenExpiresUtc:
type: string
format: date-time
description: REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired. In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
description: |
REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
Expand All @@ -522,7 +525,11 @@ components:
accessTokenExpiresUtc:
type: string
format: date-time
description: REQUIRED. An absolute UTC instant at which the token shall be considered expired.
description: |
REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
Expand Down Expand Up @@ -609,7 +616,6 @@ components:
description: |
Date when the event subscription will begin/began
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
type: string
format: date-time
example: "2023-07-03T12:27:08.312Z"
Expand All @@ -619,7 +625,6 @@ components:
description: |
Date when the event subscription will expire. Only provided when `subscriptionExpireTime` is indicated by API client or Telco Operator has specific policy about that.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
example: "2023-07-03T12:27:08.312Z"
status:
type: string
Expand Down Expand Up @@ -716,7 +721,7 @@ components:
DateTime:
type: string
format: date-time
description: Timestamp of when the occurrence happened. Must adhere to RFC 3339.
description: Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: "2018-04-05T17:31:00Z"

EventSimSwap:
Expand Down
10 changes: 5 additions & 5 deletions code/API_definitions/sim-swap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 2.1.0-rc.2
version: wip
x-camara-commonalities: 0.6
externalDocs:
description: Product documentation at Camara
url: https://github.com/camaraproject/SimSwap
servers:
- url: "{apiRoot}/sim-swap/v2rc2"
- url: "{apiRoot}/sim-swap/vwip"
variables:
apiRoot:
default: http://localhost:9091
Expand Down Expand Up @@ -225,7 +225,7 @@ components:
latestSimChange:
type: string
format: date-time
description: Timestamp of latest SIM swap performed. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
description: Timestamp of latest SIM swap performed. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
nullable: true
example: "2023-07-03T14:27:08.312+02:00"
monitoredPeriod:
Expand Down Expand Up @@ -258,10 +258,10 @@ components:
description: HTTP response status code
code:
type: string
description: Code given to this error
description: A human-readable code to describe the error
message:
type: string
description: Detailed error description
description: A human-readable description of what the event represents
CreateCheckSimSwap:
type: object
properties:
Expand Down