### Provide GitHub-Specific Operation Metadata Source: https://github.com/github/rest-api-description/blob/main/extensions.md The `x-github` extension provides extra information for generating Octokit SDKs. It can include flags for app enablement, GitHub Cloud exclusivity, and API previews. Applies to the Operation Object. ```yaml x-github: enabledForGitHubApps: true githubCloudOnly: false previews: [] ``` -------------------------------- ### x-github Extension Source: https://github.com/github/rest-api-description/blob/main/extensions.md The `x-github` extension provides additional information for generating Octokit SDKs, including notification triggers, deprecation dates, and app enablement. ```APIDOC ## x-github Extension ### Purpose Provides extra information used to generate Octokit SDKs. ### Usage The `x-github` specification extension is applied to the [Operation Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#operationObject). | Field Name | Type | Description | | :---------- | :------: | :----------- | | triggersNotification | boolean | Operations that trigger notification are more likely to trigger abuse limits. We increase the default throttling from 1s between requests to 3s between requests for these operations. | | deprecationDate | string | The date when we publicly announce that the operation will eventually be removed. After this date, the `deprecated` property should also be set to `true`. Format: `YYYY-MM-DD` | | removalDate | string | The date when we stop displaying documentation for the operation on docs.github.com and stop including it in new Octokit major versions. Format: `YYYY-MM-DD` | | githubCloudOnly | boolean | Used in a [separate plugin](https://github.com/octokit/plugin-enterprise-cloud.js/) for GitHub Enterprise Cloud users. | | enabledForGitHubApps | boolean | True if this operation is enabled for apps | | previews | array | Previews will be deprecated soon. An array of API previews, with name, description, and whether the preview is required for this particular operation. | #### Example usage ```yml x-github: enabledForGitHubApps: true githubCloudOnly: false previews: [] ``` ``` -------------------------------- ### Mark Path Parameter for Multi-Segment Support Source: https://github.com/github/rest-api-description/blob/main/extensions.md Use `x-multi-segment` on path parameters to indicate support for multiple URL segments. It's recommended to use URL-encoded values when possible. Defaults to false. Applies to path parameters. ```yaml - name: ref in: path required: true schema: type: string x-multi-segment: true ``` -------------------------------- ### x-displayName Extension Source: https://github.com/github/rest-api-description/blob/main/extensions.md The `x-displayName` extension is used to define a human-readable display name for tags in documentation interfaces. ```APIDOC ## x-displayName Extension ### Purpose To define a display name, typically for documentation interfaces, for the corresponding tag. ### Usage This applies to the [Tag Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#tagObject). The value should be a string. #### Example usage ```yml tags: name: actions description: Endpoints to manage GitHub Actions using the REST API. x-displayName: GitHub Actions ``` ``` -------------------------------- ### x-multi-segment Extension Source: https://github.com/github/rest-api-description/blob/main/extensions.md The `x-multi-segment` extension indicates that a path parameter can support multiple URL segments, useful for flexible routing. ```APIDOC ## x-multi-segment Extension Path parameter extension marking a certain parameter as supporting multiple URL segments. It's recommended to use an URL encoded value when possible. ### Usage The `x-multi-segment` extension applies only on [path parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#parameter-object). The value should be a boolean. Defaults to false. #### Example ```yml - name: ref in: path required: true schema: type: string x-multi-segment: true ``` ``` -------------------------------- ### Define Display Name for Tag Object Source: https://github.com/github/rest-api-description/blob/main/extensions.md Use `x-displayName` to provide a human-readable name for a tag, typically used in documentation interfaces. Applies to the Tag Object. ```yaml tags: name: actions description: Endpoints to manage GitHub Actions using the REST API. x-displayName: GitHub Actions ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.