Skip to content

Update feature files to reference new XCorrelator #162

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
maheshc01 merged 2 commits into from
Jul 28, 2025
Merged

Update feature files to reference new XCorrelator #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef11138
Update feature files to reference new XCorrelator
benhepworth Jul 17, 2025
3d43a42
Align with Commonalities 0.6 XCorrelator pattern
benhepworth Jul 17, 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
8 changes: 4 additions & 4 deletions code/API_definitions/connectivity-insights-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,10 +570,10 @@ components:
networks it corresponds to the MSISDN (Mobile Station International
Subscriber Directory Number). In order to be globally unique it has to
be formatted in international format, according to E.164 standard,
optionally prefixed with '+'.
prefixed with '+'.
type: string
pattern: '^\+?[0-9]{5,15}$'
example: "123456789"
pattern: '^\+[1-9][0-9]{4,14}$'
example: "+123456789"

DeviceIpv4Addr:
type: object
Expand Down Expand Up @@ -1336,7 +1336,7 @@ components:
Generic429:
description: Too Many Requests
headers:
X-Correlator:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
Expand Down
21 changes: 17 additions & 4 deletions code/API_definitions/connectivity-insights.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ paths:
level of confidence that it can meet an application profile's quality
thresholds for a given end user device.
operationId: checkNetworkQuality
parameters:
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: |
An `ApplicationProfileId` and one or more device identifiers.
Expand Down Expand Up @@ -167,13 +169,24 @@ components:
type: openIdConnect
description: Common security scheme for all CAMARA APIs
openIdConnectUrl: https://example.com/.well-known/openid-configuration
parameters:
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
headers:
x-correlator:
description: Correlation id for the different services
schema:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
$ref: "#/components/schemas/XCorrelator"
schemas:
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"

NetworkQualityInsightRequest:
description: |
request body to query the network quality for a given device and
Expand Down Expand Up @@ -312,8 +325,8 @@ components:
be formatted in international format, according to E.164 standard,
optionally prefixed with '+'.
Copy link
Copy Markdown
Collaborator

@rartych rartych Jul 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
optionally prefixed with '+'.
prefixed with '+'.

type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "123456789"
pattern: '^\+[1-9][0-9]{4,14}$'
example: "+123456789"

DeviceIpv4Addr:
type: object
Expand Down
2 changes: 1 addition & 1 deletion code/Test_definitions/application-profiles.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Feature: CAMARA Application Profiles API, v0.4.0 - Operations for Application Pr
Given the resource "{apiroot}/application-profiles/v0.4" as base-url
And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
And the header "x-correlator" is set to a UUID value
And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

######### Happy Path Scenarios #################################

Expand Down
2 changes: 1 addition & 1 deletion code/Test_definitions/connectivity-insights.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Feature: CAMARA Connectivity Insights API, v0.5.0 - Operations for Network Quali
Given the resource "{apiroot}/connectivity-insights/v0.5" as base-url
And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
And the header "x-correlator" is set to a UUID value
And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

######### Happy Path Scenarios #################################

Expand Down