Skip to content

@W-23431001: api-manager operationId + summary cleanup - #194

Open
spezzirriemiliano wants to merge 1 commit into
masterfrom
worktree-w-23431001-api-manager-cleanup
Open

@W-23431001: api-manager operationId + summary cleanup#194
spezzirriemiliano wants to merge 1 commit into
masterfrom
worktree-w-23431001-api-manager-cleanup

Conversation

@spezzirriemiliano

Copy link
Copy Markdown
Contributor

Applied cleanup for apis/api-manager:

  • 118 operationId renames (verbose By-prefixed forms -> resource-focused names)
  • Summary lines added / normalized (imperative mood, no trailing period)
  • 7 internal x-origin cross-refs patched to renamed operations
  • 4 skill files patched (SKILL.md operationId refs + prose backtick mentions):
    • skills/secure-api
    • skills/secure-agent
    • skills/secure-mcp-server
    • skills/apply-policy-to-api-instance

Applied cleanup for apis/api-manager:
- 118 operationId renames (verbose By-prefixed forms -> resource-focused names)
- Summary lines added / normalized (imperative mood, no trailing period)
- 7 internal x-origin cross-refs patched to renamed operations
- 4 skill files patched (SKILL.md operationId refs + prose backtick mentions):
  - skills/secure-api
  - skills/secure-agent
  - skills/secure-mcp-server
  - skills/apply-policy-to-api-instance

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@spezzirriemiliano
spezzirriemiliano requested review from a team as code owners July 24, 2026 18:30
Comment thread apis/api-manager/api.yaml
- type: boolean
operationId: listOrganizationsEnvironmentsApis
summary: List APIs
operationId: listApis

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's rename it to listApiInstances

Comment thread apis/api-manager/api.yaml
description: Request body containing the data needed for this operation.
operationId: createOrganizationsEnvironmentsApis
summary: Create an API
operationId: createApi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

createApiInstance

Comment thread apis/api-manager/api.yaml
default: false
operationId: getOrganizationsEnvironmentsApis
summary: Get an API
operationId: getApi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

getApiInstance

Comment thread apis/api-manager/api.yaml
description: Request body containing the data needed for this operation.
operationId: updateOrganizationsEnvironmentsApis
summary: Replace an API
operationId: updateApi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

updateApiInstace

Comment thread apis/api-manager/api.yaml
required: true
description: Request body containing the data needed for this operation.
operationId: updateOrganizationsEnvironmentsApis
summary: Replace an API

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's only an update... not a replacement.

Comment thread apis/api-manager/api.yaml
default: false
operationId: patchOrganizationsEnvironmentsApis
summary: Update an API
operationId: patchApi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same... patchApiInstance

Comment thread apis/api-manager/api.yaml
description: "Deletes an API\n\nConnected Apps require the following scopes:\n - Manage APIs Configuration\n"
operationId: deleteOrganizationsEnvironmentsApis
summary: Delete an API
operationId: deleteApi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

instace

Comment thread apis/api-manager/api.yaml
description: "Pins an environment API version\n\nConnected Apps require the following scopes:\n - View APIs Configuration\n"
operationId: updateOrganizationsEnvironmentsApisPin
summary: Pin an API version
operationId: pinApi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

instance

Comment thread apis/api-manager/api.yaml
description: Request body containing the data needed for this operation.
operationId: createOrganizationsEnvironmentsApisUpstreams
summary: Create an API upstream
operationId: createApiUpstream

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All this operations (upstreams, policies, tiers)... can be renamed to use "instance" instead of api... you know createInstanceUpstream

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This comment does not include ApiGroups... that it's another concept.

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.

2 participants