Skip to content

Use singular "credential" noun in API paths and tags#558

Open
Copilot wants to merge 4 commits intoschemas/credentialsfrom
copilot/sub-pr-557
Open

Use singular "credential" noun in API paths and tags#558
Copilot wants to merge 4 commits intoschemas/credentialsfrom
copilot/sub-pr-557

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 13, 2026

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:

  • Updated all operation tags from Credentials to Credential (5 endpoints: GET list, POST, PUT, DELETE, GET by ID)

Response Description Changes:

  • Removed "successfully" from response descriptions to make them more concise:
    • "Credential created successfully" → "Credential created"
    • "Credential updated successfully" → "Credential updated"
    • "Credential deleted successfully" → "Credential deleted"

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.

@ritzorama
Copy link
Copy Markdown
Member

@copilot also, remove use of the word "successfully" and the word "success".

Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
@ritzorama ritzorama marked this pull request as ready for review January 13, 2026 22:30
Copilot AI review requested due to automatic review settings January 13, 2026 22:30
Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
Copilot AI changed the title [WIP] Add credential schema Use singular "credential" noun in API paths and tags Jan 13, 2026
Copilot AI requested a review from ritzorama January 13, 2026 22:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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/credentials to /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:
Copy link

Copilot AI Jan 13, 2026

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/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.

Copilot uses AI. Check for mistakes.
description: Server error

/api/integrations/credentials/{id}:
/api/integrations/credential/{id}:
Copy link

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
@ritzorama
Copy link
Copy Markdown
Member

@leecalcote @aabidsofi19, please note that the current API endpoint is plural.

Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 13, 2026

@copilot also, remove use of the word "successfully" and the word "success".

Removed "successfully" from all response descriptions. Changes committed in 7aeb185.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants