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

Updating the notes for the retrieve POST calls #372

Merged
merged 7 commits into from
Nov 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
2 changes: 2 additions & 0 deletions code/API_definitions/qod-provisioning.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,8 @@ paths:
- If a 2-legged access token is used, the device parameter must be provided and identify a device.
- The QoD provisioning must have been created by the same API client given in the access token.
- If no provisioning is found for the device, an error response 404 is returned with code "NOT_FOUND".
- This call uses the POST method instead of GET to comply with the [CAMARA Commonalities guidelines](https://github.com/camaraproject/Commonalities/blob/r0.4.0/documentation/API-design-guidelines.md#post-or-get-for-transferring-sensitive-or-complex-data) for sending sensitive or complex data in API calls. Since the device field may contain personally identifiable information, it should not be sent via GET.

operationId: retrieveProvisioningByDevice
parameters:
- $ref: "#/components/parameters/x-correlator"
Expand Down
2 changes: 2 additions & 0 deletions code/API_definitions/qos-profiles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ paths:
**NOTES:**
- The access token may be either a 2-legged or 3-legged access token.
- If the access token is 3-legged, all returned QoS Profiles will be available to all end users associated with the access token.
- This call uses the POST method instead of GET to comply with the CAMARA Commonalities guidelines for sending sensitive or complex data in API calls. Since the device field may contain personally identifiable information, it should not be sent via GET. Additionally, this call may include complex data structures.
[CAMARA API Design Guidelines](https://github.com/camaraproject/Commonalities/blob/r0.4.0/documentation/API-design-guidelines.md#post-or-get-for-transferring-sensitive-or-complex-data)

security:
- openId:
Expand Down
3 changes: 3 additions & 0 deletions code/API_definitions/quality-on-demand.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,9 @@ paths:
- If a 2-legged access token is used, the device parameter must be provided and identify a device.
- The session must have been created by the same API client given in the access token
- If no QoS session is found for the requested device, an empty array is returned.
- This call uses the POST method instead of GET to comply with the CAMARA Commonalities guidelines for sending sensitive or complex data in API calls. Since the device field may contain personally identifiable information, it should not be sent via GET.
[CAMARA API Design Guidelines](https://github.com/camaraproject/Commonalities/blob/r0.4.0/documentation/API-design-guidelines.md#post-or-get-for-transferring-sensitive-or-complex-data)

operationId: retrieveSessionsByDevice
parameters:
- $ref: "#/components/parameters/x-correlator"
Expand Down