refactor: update organization API operation IDs to follow REST naming conventions #847
Conversation
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
Contributor
Leopold-Cramer
commented
Jan 15, 2025
Leopold-Cramer
commented
- Changed collection GET endpoints to use 'list' prefix
- Changed single resource GET endpoints to use 'get' prefix
- Changed POST endpoints to use 'create' prefix
- Changed DELETE endpoints to use 'delete' prefix
- Updated security-related operation names for consistency
- Maintained existing operation IDs that already followed conventions
sjoubert
requested changes
Jan 16, 2025
| operationId: createOrganization | ||
| tags: | ||
| - organization | ||
| summary: Register a new organization |
Contributor
There was a problem hiding this comment.
The summaries should probably be updated accordingly too. Here it still mentions "registering" an organization. Same for delete/unregister and maybe others.
… conventions - Changed collection GET endpoints to use 'list' prefix - Changed single resource GET endpoints to use 'get' prefix - Changed POST endpoints to use 'create' prefix - Changed DELETE endpoints to use 'delete' prefix - Updated security-related operation names for consistency - Maintained existing operation IDs that already followed conventions
Leopold-Cramer
force-pushed
the
LCRA/rework_organization_openapi_operationid_PROD-14189
branch
from
28afc9d to
ffd785e
Compare
Leopold-Cramer
deleted the
LCRA/rework_organization_openapi_operationid_PROD-14189
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.