Enhance API definitions with additional descriptions - #135
Conversation
Added description for XCorrelator schema and OpenID security scheme.
CAMARA Validation — PASS0 errors, 0 warnings, 0 hints | Profile: standard |
| openId: | ||
| type: openIdConnect | ||
| openIdConnectUrl: https://example.com/.well-known/openid-configuration | ||
| description: OpenID Connect authentication via discovery metadata. |
There was a problem hiding this comment.
This will be replaced by a reference to common artefacts after Spring 26 meta.
securitySchemes:
openId:
$ref: "../common/CAMARA_common.yaml#/components/securitySchemes/openId"There was a problem hiding this comment.
Thanks @jpengar
To be sure I got it
I replace directly in the yaml
openId:
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
description: OpenID Connect authentication via discovery metadata.
by:
openId:
$ref: "../common/CAMARA_common.yaml#/components/securitySchemes/openId"
correct?
There was a problem hiding this comment.
Take a look at the following as a reference: camaraproject/ConsentManagement#29. It may help!
There was a problem hiding this comment.
For the $ref's to work, you first need to complete the update to release-plan.yaml. As part of the release automation process, a new PR like this one is created: camaraproject/ConsentManagement#28. This copies the corresponding common artefacts to the repository, as indicated in release-plan.yaml.
There was a problem hiding this comment.
Yes this is super helpful ! Thanks !
| schemas: | ||
| XCorrelator: | ||
| type: string | ||
| description: Correlator string, UUID format recommended but any string matching the pattern can be used |
There was a problem hiding this comment.
This will be replaced by a reference to common artefacts after Spring 26 meta.
components:
headers:
x-correlator:
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
parameters:
x-correlator:
$ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
2 participants
Added description for XCorrelator schema and OpenID security scheme.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Added description for XCorrelator schema and OpenID security scheme.
Which issue(s) this PR fixes:
Fixes #
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.