ref(api): use token operationIds + summary for issues/integrations/releases/workflow endpoints#117339
Draft
betegon wants to merge 1 commit into
Draft
ref(api): use token operationIds + summary for issues/integrations/releases/workflow endpoints#117339betegon wants to merge 1 commit into
betegon wants to merge 1 commit into
Conversation
…leases/workflow endpoints
operationId->token migration, batch 2 of 3 (62 ops). Sentence -> summary=,
operation_id -> camelCase REST token.
Overrides: resolveOrganization{Event,Short}Id (resolve verb + Id casing),
upload{Organization,Project}ReleaseFile, getOrganizationConfigIntegrations;
getProjectOwnership kept consistent with updateProjectOwnership. Bulk issue/
detector/workflow ops keep plural (deleteOrganizationIssues etc.).
github-actions
Bot
added
the
Scope: Backend
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
operationId→token migration, batch 2 of 3 (issues, integrations, releases, workflow_engine — 62 ops / 38 files). Sentence →
summary,operation_id→ short camelCase REST token; docs titles/slugs unchanged (derived fromsummary).Overrides where the path/verb didn't capture intent:
resolveOrganizationEventId/resolveOrganizationShortId(resolve verb +Idcasing)upload{Organization,Project}ReleaseFile,getOrganizationConfigIntegrationsgetProjectOwnershipkept consistent withupdateProjectOwnershipBulk operations correctly keep the plural form (
deleteOrganizationIssues,updateOrganizationDetectors,updateOrganizationWorkflows) vs their singular detail counterparts.Test plan
api docs testregenerates + validates the spec (--fail-on-warn).Related