What feature or product is affected?
What is the new or expected behavior?
Example
https://docs.github.com/en/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
would become
https://docs.github.com/en/rest/reference/repos#check-vulnerability-alerts
See OpenAPI spec at https://github.com/github/openapi/blob/347c7c385184352692d4118b7e8a266ccf9b7db7/definitions/operations/repos/check-vulnerability-alerts.yml#L6
How is the old or inaccurate behavior currently documented?
n/a
Who does this affect?
Every change to an #anchor name for endpoint titles requires a change in the code, due to the error handlers which include a URL to the documentation. The endpoint titles are more prone to changes, while operation IDs should be changed much less frequently, as they are consider a breaking change to some of the OpenAPI consumers, while the "summary" key is not.
The problem with the title changes might also be amplified once translations are introduced.
@zeke sent me here, we shortly discussed it today:
What is the impact to users?
n/a
Content strategy and implementation
tbd
What feature or product is affected?
What is the new or expected behavior?
Example
would become
See OpenAPI spec at https://github.com/github/openapi/blob/347c7c385184352692d4118b7e8a266ccf9b7db7/definitions/operations/repos/check-vulnerability-alerts.yml#L6
How is the old or inaccurate behavior currently documented?
n/a
Who does this affect?
Every change to an
#anchorname for endpoint titles requires a change in the code, due to the error handlers which include a URL to the documentation. The endpoint titles are more prone to changes, while operation IDs should be changed much less frequently, as they are consider a breaking change to some of the OpenAPI consumers, while the"summary"key is not.The problem with the title changes might also be amplified once translations are introduced.
@zeke sent me here, we shortly discussed it today:
What is the impact to users?
n/a
Content strategy and implementation
tbd