-
Notifications
You must be signed in to change notification settings - Fork 107
Use singular "credential" noun in API paths and tags #558
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
Open
Copilot
wants to merge
4
commits into
schemas/credentials
Choose a base branch
from
copilot/sub-pr-557
base: schemas/credentials
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
22ffbac
Initial plan
Copilot 3672247
Change API path from plural 'credentials' to singular 'credential'
Copilot 3671814
Change OpenAPI tags from plural 'Credentials' to singular 'Credential'
Copilot 7aeb185
Remove word 'successfully' from response descriptions
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,11 +5,11 @@ info: | |
| description: API for managing Meshery credentials used to store sensitive information for connections. | ||
|
|
||
| paths: | ||
| /api/integrations/credentials: | ||
| /api/integrations/credential: | ||
| get: | ||
| x-internal: ["cloud"] | ||
| tags: | ||
| - Credentials | ||
| - Credential | ||
| operationId: GetUserCredentials | ||
| summary: Get user credentials | ||
| description: Returns a paginated list of credentials for the authenticated user. | ||
|
|
@@ -54,7 +54,7 @@ paths: | |
| post: | ||
| x-internal: ["cloud"] | ||
| tags: | ||
| - Credentials | ||
| - Credential | ||
| operationId: SaveUserCredential | ||
| summary: Create a new credential | ||
| description: Creates a new credential for the authenticated user. | ||
|
|
@@ -66,7 +66,7 @@ paths: | |
| $ref: "#/components/schemas/Credential" | ||
| responses: | ||
| "201": | ||
| description: Credential created successfully | ||
| description: Credential created | ||
| content: | ||
| application/json: | ||
| schema: | ||
|
|
@@ -77,7 +77,7 @@ paths: | |
| put: | ||
| x-internal: ["cloud"] | ||
| tags: | ||
| - Credentials | ||
| - Credential | ||
| operationId: UpdateUserCredential | ||
| summary: Update an existing credential | ||
| description: Updates an existing credential for the authenticated user. | ||
|
|
@@ -89,7 +89,7 @@ paths: | |
| $ref: "#/components/schemas/Credential" | ||
| responses: | ||
| "200": | ||
| description: Credential updated successfully | ||
| description: Credential updated | ||
| content: | ||
| application/json: | ||
| schema: | ||
|
|
@@ -100,7 +100,7 @@ paths: | |
| delete: | ||
| x-internal: ["cloud"] | ||
| tags: | ||
| - Credentials | ||
| - Credential | ||
| operationId: DeleteUserCredential | ||
| summary: Delete a credential | ||
| description: Soft deletes a credential by its ID. | ||
|
|
@@ -114,15 +114,15 @@ paths: | |
| format: uuid | ||
| responses: | ||
| "200": | ||
| description: Credential deleted successfully | ||
| description: Credential deleted | ||
| "500": | ||
| description: Server error | ||
|
|
||
| /api/integrations/credentials/{id}: | ||
| /api/integrations/credential/{id}: | ||
|
||
| get: | ||
| x-internal: ["cloud"] | ||
| tags: | ||
| - Credentials | ||
| - Credential | ||
| operationId: GetCredentialByID | ||
| summary: Get a credential by ID | ||
| description: Returns a specific credential by its ID. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The API path is being changed from plural
/api/integrations/credentialsto singular/api/integrations/credential, which breaks the RESTful API convention used throughout this codebase. Other similar endpoints in the repository use plural forms (e.g.,/api/environments,/api/workspaces). This change is inconsistent with the established pattern and is a breaking API change that will affect all clients using these endpoints. Consider keeping the plural form/api/integrations/credentialsto maintain consistency with other API endpoints and avoid breaking existing integrations.