Skip to content

fix(geofencing-subscriptions): drop duplicate local x-correlator header/parameter #424

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

Open
hdamker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(geofencing-subscriptions): drop duplicate local x-correlator header/parameter #424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 19 additions & 30 deletions code/API_definitions/geofencing-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
description: Create a subscription for a device to receive notifications when the device enters or exits a specified area.
operationId: createGeofencingSubscription
parameters:
- $ref: "#/components/parameters/x-correlator"
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
security:
- openId:
- geofencing-subscriptions:org.camaraproject.geofencing-subscriptions.v0.area-entered:create
Expand All @@ -181,7 +181,7 @@
The `operationId` value will have to be replaced accordingly with WG API specific semantics.
operationId: postNotification
parameters:
- $ref: "#/components/parameters/x-correlator"
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
requestBody:
required: true
content:
Expand All @@ -206,7 +206,7 @@
description: Successful notification.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
"400":
$ref: "#/components/responses/Generic400"
"401":
Expand All @@ -225,7 +225,7 @@
description: Created (Successful creation of subscription).
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -234,7 +234,7 @@
description: Request accepted to be processed. It applies for async creation process.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -256,7 +256,7 @@
description: Retrieve a list of geofencing event subscription(s).
operationId: retrieveGeofencingSubscriptionList
parameters:
- $ref: "#/components/parameters/x-correlator"
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
security:
- openId:
- geofencing-subscriptions:read
Expand All @@ -265,7 +265,7 @@
description: List of event subscription details.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -292,13 +292,13 @@
- geofencing-subscriptions:read
parameters:
- $ref: "#/components/parameters/SubscriptionId"
- $ref: "#/components/parameters/x-correlator"
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
responses:
"200":
description: OK
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -322,18 +322,18 @@
- geofencing-subscriptions:delete
parameters:
- $ref: "#/components/parameters/SubscriptionId"
- $ref: "#/components/parameters/x-correlator"
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
responses:
"204":
description: Geofencing subscription deleted.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
"202":
description: Request accepted to be processed. It applies for async deletion process.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down Expand Up @@ -362,17 +362,6 @@
required: true
schema:
$ref: "#/components/schemas/SubscriptionId"
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services.
schema:
$ref: '../common/CAMARA_common.yaml#/components/schemas/XCorrelator'
headers:
x-correlator:
description: Correlation id for the different services.
schema:
$ref: '../common/CAMARA_common.yaml#/components/schemas/XCorrelator'
schemas:
ErrorInfo:
$ref: '../common/CAMARA_common.yaml#/components/schemas/ErrorInfo'
Expand Down Expand Up @@ -557,7 +546,7 @@
$ref: "#/components/schemas/SubscriptionEventType"
config:
$ref: "#/components/schemas/ConfigResponse"
id:

Check notice on line 549 in code/API_definitions/geofencing-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model.
Expand Down Expand Up @@ -610,16 +599,16 @@
Device:
$ref: '../common/CAMARA_common.yaml#/components/schemas/Device'

PhoneNumber:

Check warning on line 602 in code/API_definitions/geofencing-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
$ref: '../common/CAMARA_common.yaml#/components/schemas/PhoneNumber'

NetworkAccessIdentifier:

Check warning on line 605 in code/API_definitions/geofencing-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
$ref: '../common/CAMARA_common.yaml#/components/schemas/NetworkAccessIdentifier'

Port:

Check warning on line 608 in code/API_definitions/geofencing-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
$ref: '../common/CAMARA_common.yaml#/components/schemas/Port'

DeviceIpv6Address:

Check warning on line 611 in code/API_definitions/geofencing-subscriptions.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
$ref: '../common/CAMARA_common.yaml#/components/schemas/DeviceIpv6Address'

DeviceResponse:
Expand Down Expand Up @@ -893,7 +882,7 @@
description: Problem with the client request.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down Expand Up @@ -939,7 +928,7 @@
description: Problem with the client request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down Expand Up @@ -974,7 +963,7 @@
description: Client does not have sufficient permission
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -999,7 +988,7 @@
description: Not found
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -1024,7 +1013,7 @@
description: Gone
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand All @@ -1050,7 +1039,7 @@
description: Unprocessable Entity
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down Expand Up @@ -1125,7 +1114,7 @@
description: Too Many Requests
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
Expand Down
Loading