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.

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

Jump to bottom

Updating names qos-profile of endpoints #348

Merged
merged 4 commits into from
Aug 27, 2024
Merged

Updating names qos-profile of endpoints #348

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
12ac2c5
Updating names of endpoints
RandyLevensalor Aug 14, 2024
442e0c3
Update code/API_definitions/qos-profiles.yaml
RandyLevensalor Aug 20, 2024
8cac219
Incorporating feedback
RandyLevensalor Aug 23, 2024
0f43a3b
Removing verb from get call
RandyLevensalor Aug 23, 2024
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
16 changes: 10 additions & 6 deletions code/API_definitions/qos-profiles.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,17 +75,21 @@ tags:
description: Manage QoS Profiles

paths:
/qos-profiles:
/retrieve-qos-profiles:
post:
tags:
- QoS Profiles
summary: Get QoS profiles available for a given device
summary: Retrieve QoS profiles
description: |
Returns all QoS Profiles that match the given criteria.
**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.
operationId: qosProfilesDevice

security:
- openId:
- qos-profiles:read
operationId: retrieveQoSProfilesByDevice
parameters:
- $ref: "#/components/parameters/x-correlator"
requestBody:
Expand Down Expand Up @@ -124,20 +128,20 @@ paths:
"503":
$ref: "#/components/responses/Generic503"

/qos-profiles/{name}:
/retrieve-qos-profile/{name}:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I thought we were going to keep GET /qos-profiles/{name}. That would be the expected name for such an endpoint.

get:
tags:
- QoS Profiles
summary: "Get QoS Profile for a given name"
operationId: getQosProfile
operationId: retrieveQosProfile
Copy link
Collaborator

Choose a reason for hiding this comment

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

The original one was OK in line with the comment above

description: |
Returns a QoS Profile that matches the given name.

The access token may be either a 2-legged or 3-legged access token. If the access token is 3-legged, a QoS Profile is only returned if available to all end users associated with the access token.

security:
- openId:
- qos-profiles:qos-profiles:read
- qos-profiles:read
RandyLevensalor marked this conversation as resolved.
Show resolved Hide resolved
parameters:
- name: name
in: path
Expand Down