Use singular "credential" noun in API paths and tags#558
Use singular "credential" noun in API paths and tags#558Copilot wants to merge 4 commits intoschemas/credentialsfrom
Conversation
|
@copilot also, remove use of the word "successfully" and the word "success". |
Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This pull request proposes to change the API paths from plural (/api/integrations/credentials) to singular (/api/integrations/credential) for the Meshery credential management endpoints.
Changes:
- Updated base API path from
/api/integrations/credentialsto/api/integrations/credential - Updated path parameter route from
/api/integrations/credentials/{id}to/api/integrations/credential/{id}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| paths: | ||
| /api/integrations/credentials: | ||
| /api/integrations/credential: |
There was a problem hiding this comment.
The API path is being changed from plural /api/integrations/credentials to 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/credentials to maintain consistency with other API endpoints and avoid breaking existing integrations.
| description: Server error | ||
|
|
||
| /api/integrations/credentials/{id}: | ||
| /api/integrations/credential/{id}: |
There was a problem hiding this comment.
This path parameter endpoint is being changed from plural /api/integrations/credentials/{id} to singular /api/integrations/credential/{id}. This change is inconsistent with the RESTful API conventions used throughout the codebase (e.g., /api/workspaces/{id}, /api/environments/{id} use plural forms) and represents a breaking API change. To maintain consistency and avoid breaking existing client integrations, the plural form /api/integrations/credentials/{id} should be retained.
|
@leecalcote @aabidsofi19, please note that the current API endpoint is plural. |
Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
Changed API endpoint naming from plural "credentials" to singular "credential" for consistency with repository conventions.
API Path Changes:
/api/integrations/credentials→/api/integrations/credential/api/integrations/credentials/{id}→/api/integrations/credential/{id}OpenAPI Tag Changes:
CredentialstoCredential(5 endpoints: GET list, POST, PUT, DELETE, GET by ID)Response Description Changes:
All changes are in
schemas/constructs/v1beta1/credential/api.yml. Auto-generated Go and TypeScript code will be regenerated during the build process.💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.