Skip to content

Commit

Permalink
Merge pull request #3262 from github/openapi-update-ff14671fd61ae032d…
Browse files Browse the repository at this point in the history 
…dbe16bdb5074bd5ff115bc28f06235dc6998edc75f3daf2

Update OpenAPI 3.0 Descriptions
  • Loading branch information
@dinonuggies1
dinonuggies1 authored Dec 22, 2023
2 parents 908cb28 + 4dcc32e commit 469b7ec
Show file tree
Hide file tree
Showing 40 changed files with 368 additions and 152 deletions.
18 changes: 9 additions & 9 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14994,7 +14994,7 @@
"/orgs/{org}/properties/schema": {
"get": {
"summary": "Get all custom properties for an organization",
"description": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.",
"description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.\n\nGitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -15043,7 +15043,7 @@
},
"patch": {
"summary": "Create or update custom properties for an organization",
"description": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties",
"description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.\n\nGitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -15146,7 +15146,7 @@
"/orgs/{org}/properties/schema/{custom_property_name}": {
"get": {
"summary": "Get a custom property for an organization",
"description": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.",
"description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.\n\nGitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -15195,7 +15195,7 @@
},
"put": {
"summary": "Create or update a custom property for an organization",
"description": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.",
"description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.\n\nGitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -15304,7 +15304,7 @@
},
"delete": {
"summary": "Remove a custom property for an organization",
"description": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.",
"description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.\n\nGitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -15343,7 +15343,7 @@
"/orgs/{org}/properties/values": {
"get": {
"summary": "List custom property values for organization repositories",
"description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.",
"description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.\n\nGitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -15412,7 +15412,7 @@
},
"patch": {
"summary": "Create or update custom property values for organization repositories",
"description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nOnly organization owners (or users with the proper permissions granted by them) can update these properties",
"description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.\n\nGitHub Apps must have the `organization_custom_properties:write` organization permission to use this endpoint.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -30797,7 +30797,7 @@
"/repos/{owner}/{repo}/code-scanning/sarifs": {
"post": {
"summary": "Upload an analysis as SARIF data",
"description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"",
"description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"",
"operationId": "code-scanning/upload-sarif",
"tags": [
"code-scanning"
Expand Down Expand Up @@ -44327,7 +44327,7 @@
"/repos/{owner}/{repo}/properties/values": {
"get": {
"summary": "Get all custom property values for a repository",
"description": "Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.",
"description": "Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.\n\nGitHub Apps must have the `metadata:read` repository permission to use this endpoint.",
"tags": [
"repos"
],
Expand Down
41 changes: 34 additions & 7 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10772,7 +10772,9 @@ paths:
summary: Get all custom properties for an organization
description: |-
Gets all custom properties defined for an organization.
You must be an organization owner to use this endpoint.
Organization members can read these properties.

GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/get-all-custom-properties
Expand Down Expand Up @@ -10806,7 +10808,12 @@ paths:
summary: Create or update custom properties for an organization
description: |-
Creates new or updates existing custom properties defined for an organization in a batch.
Only organization owners (or users with the proper permissions granted by them) can update these properties

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.

GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/create-or-update-custom-properties
Expand Down Expand Up @@ -10874,7 +10881,9 @@ paths:
summary: Get a custom property for an organization
description: |-
Gets a custom property that is defined for an organization.
You must be an organization owner to use this endpoint.
Organization members can read these properties.

GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/get-custom-property
Expand Down Expand Up @@ -10907,7 +10916,12 @@ paths:
summary: Create or update a custom property for an organization
description: |-
Creates a new or updates an existing custom property that is defined for an organization.
You must be an organization owner to use this endpoint.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.

GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/create-or-update-custom-property
Expand Down Expand Up @@ -10983,7 +10997,12 @@ paths:
summary: Remove a custom property for an organization
description: |-
Removes a custom property that is defined for an organization.
You must be an organization owner to use this endpoint.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.

GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/remove-custom-property
Expand Down Expand Up @@ -11011,6 +11030,8 @@ paths:
description: |-
Lists organization repositories with all of their custom property values.
Organization members can read these properties.

GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/list-custom-properties-values-for-repos
Expand Down Expand Up @@ -11067,7 +11088,11 @@ paths:

Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

Only organization owners (or users with the proper permissions granted by them) can update these properties
To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.

GitHub Apps must have the `organization_custom_properties:write` organization permission to use this endpoint.
tags:
- orgs
operationId: orgs/create-or-update-custom-properties-values-for-repos
Expand Down Expand Up @@ -22075,7 +22100,7 @@ paths:
see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou
must compress the SARIF-formatted analysis data that you want to upload, using
`gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip
-c analysis-data.sarif | base64 -w0\n```\n<br>\nSARIF upload supports a maximum
-c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum
number of entries per the following data objects, and an analysis will be
rejected if any of these objects is above its maximum value. For some objects,
there are additional values over which the entries will be ignored while keeping
Expand Down Expand Up @@ -31767,6 +31792,8 @@ paths:
description: |-
Gets all custom property values that are set for a repository.
Users with read access to the repository can use this endpoint.

GitHub Apps must have the `metadata:read` repository permission to use this endpoint.
tags:
- repos
operationId: repos/get-custom-properties-values
Expand Down
Loading

0 comments on commit 469b7ec

Please sign in to comment.