Update OpenAPI Description (#56478)
Co-authored-by: John Clement <70238417+jclement136@users.noreply.github.com>
This commit is contained in:
docs-bot
13
content/rest/models/embeddings.md
Normal file
13
content/rest/models/embeddings.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: REST API endpoints for model embeddings
|
||||
shortTitle: Embeddings
|
||||
intro: Use the REST API to work with embedding requests for models.
|
||||
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
|
||||
fpt: '*'
|
||||
topics:
|
||||
- API
|
||||
autogenerated: rest
|
||||
allowTitleToDifferFromFilename: true
|
||||
---
|
||||
|
||||
<!-- Content after this section is automatically generated -->
|
||||
@@ -6,7 +6,9 @@ autogenerated: rest
|
||||
allowTitleToDifferFromFilename: true
|
||||
children:
|
||||
- /catalog
|
||||
- /embeddings
|
||||
- /inference
|
||||
versions:
|
||||
fpt: '*'
|
||||
---
|
||||
|
||||
|
||||
@@ -60,5 +60,5 @@
|
||||
"2022-11-28"
|
||||
]
|
||||
},
|
||||
"sha": "527d41e4237d9ad0bac93932fe1d2fb22f8d1b97"
|
||||
"sha": "664cf25da36ebb8f97693e51663addaed26bbae5"
|
||||
}
|
||||
@@ -170558,6 +170558,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
@@ -176098,7 +176102,7 @@
|
||||
"type": "array of integers",
|
||||
"name": "selected_repository_ids",
|
||||
"in": "body",
|
||||
"description": "<p>An array of repository IDs to detach from configurations.</p>"
|
||||
"description": "<p>An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.</p>"
|
||||
}
|
||||
],
|
||||
"progAccess": {
|
||||
@@ -388924,6 +388928,388 @@
|
||||
]
|
||||
}
|
||||
],
|
||||
"embeddings": [
|
||||
{
|
||||
"serverUrl": "https://models.github.ai",
|
||||
"verb": "post",
|
||||
"requestPath": "/orgs/{org}/inference/embeddings",
|
||||
"title": "Run an embedding request attributed to an organization",
|
||||
"category": "models",
|
||||
"subcategory": "embeddings",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"name": "api-version",
|
||||
"description": "<p>The API version to use. Optional, but required for some features.</p>",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "2024-05-01-preview"
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "org",
|
||||
"required": true,
|
||||
"description": "<p>The organization login associated with the organization to which the request is to be attributed.</p>",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "model",
|
||||
"in": "body",
|
||||
"description": "<p>ID of the specific model to use for the request. The model ID should be in the format of {publisher}/{model_name} where \"openai/text-embedding-3-small\" is an example of a model ID. You can find supported models in the catalog/models endpoint.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string or array",
|
||||
"name": "input",
|
||||
"in": "body",
|
||||
"description": "<p>Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. Each input must not exceed the max input tokens for the model, cannot be an empty string, and any array must be 2048 dimensions or less.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "encoding_format",
|
||||
"in": "body",
|
||||
"description": "<p>The format to return the embeddings in. Can be either float or base64.</p>",
|
||||
"enum": [
|
||||
"float",
|
||||
"base64"
|
||||
],
|
||||
"default": "float"
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"name": "dimensions",
|
||||
"in": "body",
|
||||
"description": "<p>The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "user",
|
||||
"in": "body",
|
||||
"description": "<p>A unique identifier representing your end-user, which can help us to monitor and detect abuse.</p>"
|
||||
}
|
||||
],
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"input": [
|
||||
"The food was delicious and the waiter was very friendly.",
|
||||
"I had a great time at the restaurant."
|
||||
]
|
||||
},
|
||||
"parameters": {
|
||||
"org": "ORG"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "",
|
||||
"example": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "embedding",
|
||||
"index": 0,
|
||||
"embedding": [
|
||||
0.0023064255,
|
||||
-0.009327292,
|
||||
-0.0028842222
|
||||
]
|
||||
}
|
||||
],
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"usage": {
|
||||
"prompt_tokens": 8,
|
||||
"total_tokens": 8
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"title": "Embedding Response",
|
||||
"description": "The response for an embedding request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"list\" for embedding responses.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"list"
|
||||
]
|
||||
},
|
||||
"data": {
|
||||
"description": "A list of embedding objects.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"title": "Embedding Object",
|
||||
"description": "An embedding vector returned by the model.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"embedding\".",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"embedding"
|
||||
]
|
||||
},
|
||||
"index": {
|
||||
"description": "The index of the embedding in the list of embeddings.",
|
||||
"type": "integer"
|
||||
},
|
||||
"embedding": {
|
||||
"description": "The embedding vector, which is a list of floats.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"index",
|
||||
"embedding"
|
||||
]
|
||||
}
|
||||
},
|
||||
"model": {
|
||||
"description": "The model used for the embedding.",
|
||||
"type": "string"
|
||||
},
|
||||
"usage": {
|
||||
"description": "Usage statistics for the request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"prompt_tokens": {
|
||||
"description": "The number of tokens in the input.",
|
||||
"type": "integer"
|
||||
},
|
||||
"total_tokens": {
|
||||
"description": "The total number of tokens processed.",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"prompt_tokens",
|
||||
"total_tokens"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"data",
|
||||
"model",
|
||||
"usage"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://models.github.ai",
|
||||
"verb": "post",
|
||||
"requestPath": "/inference/embeddings",
|
||||
"title": "Run an embedding request",
|
||||
"category": "models",
|
||||
"subcategory": "embeddings",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"name": "api-version",
|
||||
"description": "<p>The API version to use. Optional, but required for some features.</p>",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "2024-05-01-preview"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "model",
|
||||
"in": "body",
|
||||
"description": "<p>ID of the specific model to use for the request. The model ID should be in the format of {publisher}/{model_name} where \"openai/text-embedding-3-small\" is an example of a model ID. You can find supported models in the catalog/models endpoint.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string or array",
|
||||
"name": "input",
|
||||
"in": "body",
|
||||
"description": "<p>Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. Each input must not exceed the max input tokens for the model, cannot be an empty string, and any array must be 2048 dimensions or less.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "encoding_format",
|
||||
"in": "body",
|
||||
"description": "<p>The format to return the embeddings in. Can be either float or base64.</p>",
|
||||
"enum": [
|
||||
"float",
|
||||
"base64"
|
||||
],
|
||||
"default": "float"
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"name": "dimensions",
|
||||
"in": "body",
|
||||
"description": "<p>The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "user",
|
||||
"in": "body",
|
||||
"description": "<p>A unique identifier representing your end-user, which can help us to monitor and detect abuse.</p>"
|
||||
}
|
||||
],
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"input": [
|
||||
"The food was delicious and the waiter was very friendly.",
|
||||
"I had a great time at the restaurant."
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "",
|
||||
"example": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "embedding",
|
||||
"index": 0,
|
||||
"embedding": [
|
||||
0.0023064255,
|
||||
-0.009327292,
|
||||
-0.0028842222
|
||||
]
|
||||
}
|
||||
],
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"usage": {
|
||||
"prompt_tokens": 8,
|
||||
"total_tokens": 8
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"title": "Embedding Response",
|
||||
"description": "The response for an embedding request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"list\" for embedding responses.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"list"
|
||||
]
|
||||
},
|
||||
"data": {
|
||||
"description": "A list of embedding objects.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"title": "Embedding Object",
|
||||
"description": "An embedding vector returned by the model.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"embedding\".",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"embedding"
|
||||
]
|
||||
},
|
||||
"index": {
|
||||
"description": "The index of the embedding in the list of embeddings.",
|
||||
"type": "integer"
|
||||
},
|
||||
"embedding": {
|
||||
"description": "The embedding vector, which is a list of floats.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"index",
|
||||
"embedding"
|
||||
]
|
||||
}
|
||||
},
|
||||
"model": {
|
||||
"description": "The model used for the embedding.",
|
||||
"type": "string"
|
||||
},
|
||||
"usage": {
|
||||
"description": "Usage statistics for the request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"prompt_tokens": {
|
||||
"description": "The number of tokens in the input.",
|
||||
"type": "integer"
|
||||
},
|
||||
"total_tokens": {
|
||||
"description": "The total number of tokens processed.",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"prompt_tokens",
|
||||
"total_tokens"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"data",
|
||||
"model",
|
||||
"usage"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint allows you to run an embedding request. The token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"inference": [
|
||||
{
|
||||
"serverUrl": "https://models.github.ai",
|
||||
@@ -389600,386 +389986,6 @@
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://models.github.ai",
|
||||
"verb": "post",
|
||||
"requestPath": "/orgs/{org}/inference/embeddings",
|
||||
"title": "Run an embedding request attributed to an organization",
|
||||
"category": "models",
|
||||
"subcategory": "inference",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"name": "api-version",
|
||||
"description": "<p>The API version to use. Optional, but required for some features.</p>",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "2024-05-01-preview"
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "org",
|
||||
"required": true,
|
||||
"description": "<p>The organization login associated with the organization to which the request is to be attributed.</p>",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "model",
|
||||
"in": "body",
|
||||
"description": "<p>ID of the specific model to use for the request. The model ID should be in the format of {publisher}/{model_name} where \"openai/text-embedding-3-small\" is an example of a model ID. You can find supported models in the catalog/models endpoint.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string or array",
|
||||
"name": "input",
|
||||
"in": "body",
|
||||
"description": "<p>Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. Each input must not exceed the max input tokens for the model, cannot be an empty string, and any array must be 2048 dimensions or less.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "encoding_format",
|
||||
"in": "body",
|
||||
"description": "<p>The format to return the embeddings in. Can be either float or base64.</p>",
|
||||
"enum": [
|
||||
"float",
|
||||
"base64"
|
||||
],
|
||||
"default": "float"
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"name": "dimensions",
|
||||
"in": "body",
|
||||
"description": "<p>The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "user",
|
||||
"in": "body",
|
||||
"description": "<p>A unique identifier representing your end-user, which can help us to monitor and detect abuse.</p>"
|
||||
}
|
||||
],
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"input": [
|
||||
"The food was delicious and the waiter was very friendly.",
|
||||
"I had a great time at the restaurant."
|
||||
]
|
||||
},
|
||||
"parameters": {
|
||||
"org": "ORG"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "",
|
||||
"example": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "embedding",
|
||||
"index": 0,
|
||||
"embedding": [
|
||||
0.0023064255,
|
||||
-0.009327292,
|
||||
-0.0028842222
|
||||
]
|
||||
}
|
||||
],
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"usage": {
|
||||
"prompt_tokens": 8,
|
||||
"total_tokens": 8
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"title": "Embedding Response",
|
||||
"description": "The response for an embedding request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"list\" for embedding responses.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"list"
|
||||
]
|
||||
},
|
||||
"data": {
|
||||
"description": "A list of embedding objects.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"title": "Embedding Object",
|
||||
"description": "An embedding vector returned by the model.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"embedding\".",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"embedding"
|
||||
]
|
||||
},
|
||||
"index": {
|
||||
"description": "The index of the embedding in the list of embeddings.",
|
||||
"type": "integer"
|
||||
},
|
||||
"embedding": {
|
||||
"description": "The embedding vector, which is a list of floats.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"index",
|
||||
"embedding"
|
||||
]
|
||||
}
|
||||
},
|
||||
"model": {
|
||||
"description": "The model used for the embedding.",
|
||||
"type": "string"
|
||||
},
|
||||
"usage": {
|
||||
"description": "Usage statistics for the request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"prompt_tokens": {
|
||||
"description": "The number of tokens in the input.",
|
||||
"type": "integer"
|
||||
},
|
||||
"total_tokens": {
|
||||
"description": "The total number of tokens processed.",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"prompt_tokens",
|
||||
"total_tokens"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"data",
|
||||
"model",
|
||||
"usage"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://models.github.ai",
|
||||
"verb": "post",
|
||||
"requestPath": "/inference/embeddings",
|
||||
"title": "Run an embedding request",
|
||||
"category": "models",
|
||||
"subcategory": "inference",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"name": "api-version",
|
||||
"description": "<p>The API version to use. Optional, but required for some features.</p>",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "2024-05-01-preview"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "model",
|
||||
"in": "body",
|
||||
"description": "<p>ID of the specific model to use for the request. The model ID should be in the format of {publisher}/{model_name} where \"openai/text-embedding-3-small\" is an example of a model ID. You can find supported models in the catalog/models endpoint.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string or array",
|
||||
"name": "input",
|
||||
"in": "body",
|
||||
"description": "<p>Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. Each input must not exceed the max input tokens for the model, cannot be an empty string, and any array must be 2048 dimensions or less.</p>",
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "encoding_format",
|
||||
"in": "body",
|
||||
"description": "<p>The format to return the embeddings in. Can be either float or base64.</p>",
|
||||
"enum": [
|
||||
"float",
|
||||
"base64"
|
||||
],
|
||||
"default": "float"
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"name": "dimensions",
|
||||
"in": "body",
|
||||
"description": "<p>The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "user",
|
||||
"in": "body",
|
||||
"description": "<p>A unique identifier representing your end-user, which can help us to monitor and detect abuse.</p>"
|
||||
}
|
||||
],
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"input": [
|
||||
"The food was delicious and the waiter was very friendly.",
|
||||
"I had a great time at the restaurant."
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "",
|
||||
"example": {
|
||||
"object": "list",
|
||||
"data": [
|
||||
{
|
||||
"object": "embedding",
|
||||
"index": 0,
|
||||
"embedding": [
|
||||
0.0023064255,
|
||||
-0.009327292,
|
||||
-0.0028842222
|
||||
]
|
||||
}
|
||||
],
|
||||
"model": "openai/text-embedding-3-small",
|
||||
"usage": {
|
||||
"prompt_tokens": 8,
|
||||
"total_tokens": 8
|
||||
}
|
||||
},
|
||||
"schema": {
|
||||
"title": "Embedding Response",
|
||||
"description": "The response for an embedding request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"list\" for embedding responses.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"list"
|
||||
]
|
||||
},
|
||||
"data": {
|
||||
"description": "A list of embedding objects.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"title": "Embedding Object",
|
||||
"description": "An embedding vector returned by the model.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"object": {
|
||||
"description": "The object type, which is always \"embedding\".",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"embedding"
|
||||
]
|
||||
},
|
||||
"index": {
|
||||
"description": "The index of the embedding in the list of embeddings.",
|
||||
"type": "integer"
|
||||
},
|
||||
"embedding": {
|
||||
"description": "The embedding vector, which is a list of floats.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"index",
|
||||
"embedding"
|
||||
]
|
||||
}
|
||||
},
|
||||
"model": {
|
||||
"description": "The model used for the embedding.",
|
||||
"type": "string"
|
||||
},
|
||||
"usage": {
|
||||
"description": "Usage statistics for the request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"prompt_tokens": {
|
||||
"description": "The number of tokens in the input.",
|
||||
"type": "integer"
|
||||
},
|
||||
"total_tokens": {
|
||||
"description": "The total number of tokens processed.",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"prompt_tokens",
|
||||
"total_tokens"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"object",
|
||||
"data",
|
||||
"model",
|
||||
"usage"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint allows you to run an embedding request. The token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -181665,6 +181665,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
@@ -188519,7 +188523,7 @@
|
||||
"type": "array of integers",
|
||||
"name": "selected_repository_ids",
|
||||
"in": "body",
|
||||
"description": "<p>An array of repository IDs to detach from configurations.</p>"
|
||||
"description": "<p>An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.</p>"
|
||||
}
|
||||
],
|
||||
"progAccess": {
|
||||
@@ -284416,6 +284420,116 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "post",
|
||||
"requestPath": "/enterprises/{enterprise}/settings/billing/cost-centers",
|
||||
"title": "Create a new cost center",
|
||||
"category": "enterprise-admin",
|
||||
"subcategory": "billing",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"description": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "name",
|
||||
"in": "body",
|
||||
"description": "<p>The name of the cost center (max length 255 characters)</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"progAccess": {
|
||||
"userToServerRest": false,
|
||||
"serverToServer": false,
|
||||
"fineGrainedPat": false,
|
||||
"permissions": []
|
||||
},
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "example-1",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example request to create a cost center",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"name": "Engineering Team"
|
||||
},
|
||||
"parameters": {
|
||||
"enterprise": "ENTERPRISE"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Example response for a created cost center</p>",
|
||||
"example": {
|
||||
"id": "abc123",
|
||||
"name": "Engineering Team",
|
||||
"resources": []
|
||||
},
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the cost center"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name of the cost center"
|
||||
},
|
||||
"resources": {
|
||||
"type": "array",
|
||||
"description": "List of resources assigned to this cost center",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Type of resource (User, Org, or Repo)"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name/login of the resource"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Creates a new cost center for an enterprise. The authenticated user must be an enterprise admin.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>Cost center created successfully</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "400",
|
||||
"description": "<p>Bad request</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Conflict</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "500",
|
||||
"description": "<p>Internal server error</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
@@ -284819,7 +284933,7 @@
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "post",
|
||||
"requestPath": "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource",
|
||||
"title": "Add users to a cost center",
|
||||
"title": "Add resources to a cost center",
|
||||
"category": "enterprise-admin",
|
||||
"subcategory": "billing",
|
||||
"parameters": [
|
||||
@@ -284848,6 +284962,18 @@
|
||||
"name": "users",
|
||||
"in": "body",
|
||||
"description": "<p>The usernames of the users to add to the cost center.</p>"
|
||||
},
|
||||
{
|
||||
"type": "array of strings",
|
||||
"name": "organizations",
|
||||
"in": "body",
|
||||
"description": "<p>The organizations to add to the cost center.</p>"
|
||||
},
|
||||
{
|
||||
"type": "array of strings",
|
||||
"name": "repositories",
|
||||
"in": "body",
|
||||
"description": "<p>The repositories to add to the cost center.</p>"
|
||||
}
|
||||
],
|
||||
"progAccess": {
|
||||
@@ -284892,7 +285018,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds users to a cost center.</p>\n<p>The usage for the users will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Adds resources to a cost center.</p>\n<p>The usage for the resources will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -284924,7 +285050,7 @@
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "delete",
|
||||
"requestPath": "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource",
|
||||
"title": "Remove users from a cost center",
|
||||
"title": "Remove resources from a cost center",
|
||||
"category": "enterprise-admin",
|
||||
"subcategory": "billing",
|
||||
"parameters": [
|
||||
@@ -284953,6 +285079,18 @@
|
||||
"name": "users",
|
||||
"in": "body",
|
||||
"description": "<p>The usernames of the users to remove from the cost center.</p>"
|
||||
},
|
||||
{
|
||||
"type": "array of strings",
|
||||
"name": "organizations",
|
||||
"in": "body",
|
||||
"description": "<p>The organizations to remove from the cost center.</p>"
|
||||
},
|
||||
{
|
||||
"type": "array of strings",
|
||||
"name": "repositories",
|
||||
"in": "body",
|
||||
"description": "<p>The repositories to remove from the cost center.</p>"
|
||||
}
|
||||
],
|
||||
"progAccess": {
|
||||
@@ -284997,7 +285135,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Remove users from a cost center.</p>\n<p>The usage for the users will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Remove resources from a cost center.</p>\n<p>The usage for the resources will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -1846,13 +1846,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the GitHub Actions caches for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the GitHub Actions caches for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -2836,13 +2836,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -3503,13 +3503,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -4668,13 +4668,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -4737,13 +4737,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -5112,13 +5112,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -7636,7 +7636,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for\nrepository access is set to <code>selected</code>. For more information about setting the visibility, see <a href=\"https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret\">Create or\nupdate an organization secret</a>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -7646,7 +7645,8 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Conflict when visibility type is not set to selected</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for\nrepository access is set to <code>selected</code>. For more information about setting the visibility, see <a href=\"https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret\">Create or\nupdate an organization secret</a>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -10210,13 +10210,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -11398,13 +11398,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -12618,13 +12618,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the repositories with access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the repositories with access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -12772,13 +12772,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -22404,13 +22404,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -28105,13 +28105,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific job in a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific job in a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -29355,7 +29355,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Re-run a job and its dependent jobs in a workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -29365,7 +29364,8 @@
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Re-run a job and its dependent jobs in a workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -35402,13 +35402,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -38165,13 +38165,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific workflow run attempt.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific workflow run attempt.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -43686,13 +43686,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Disables a workflow and sets the <code>state</code> of the workflow to <code>disabled_manually</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Disables a workflow and sets the <code>state</code> of the workflow to <code>disabled_manually</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -78406,13 +78406,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>"
|
||||
}
|
||||
],
|
||||
"notifications": [
|
||||
@@ -99842,13 +99842,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -131740,7 +131740,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists the teams who have push access to this branch. The list includes child teams.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -131750,7 +131749,8 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists the teams who have push access to this branch. The list includes child teams.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -149905,13 +149905,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a single check suite using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a single check suite using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -158952,6 +158952,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
@@ -185924,13 +185928,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -186908,13 +186912,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -201073,13 +201077,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -202108,13 +202112,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the audit log for an enterprise.</p>\n<p>The authenticated user must be an enterprise admin to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the audit log for an enterprise.</p>\n<p>The authenticated user must be an enterprise admin to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
}
|
||||
],
|
||||
"billing": [
|
||||
@@ -202305,13 +202309,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an enterprise per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of active_users for each repository.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>Success</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an enterprise per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of active_users for each repository.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>"
|
||||
}
|
||||
],
|
||||
"code-security-and-analysis": [
|
||||
@@ -205025,7 +205029,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.</p>\n<div class=\"ghd-alert ghd-alert-done\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Important</p>\n<p>\nTo start the configuration process and apply the license, you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process\"><code>/manage/v1/config/apply</code></a></p>\n</div>\n<p>The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "202",
|
||||
@@ -205043,7 +205046,8 @@
|
||||
"httpStatusCode": "500",
|
||||
"description": "<p>Internal error</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.</p>\n<div class=\"ghd-alert ghd-alert-done\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Important</p>\n<p>\nTo start the configuration process and apply the license, you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process\"><code>/manage/v1/config/apply</code></a></p>\n</div>\n<p>The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>\n</div>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME",
|
||||
@@ -220802,7 +220806,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -220816,7 +220819,8 @@
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -268966,13 +268970,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -293135,13 +293139,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates a label using the given label name.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates a label using the given label name.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -293401,13 +293405,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists labels for issues in a milestone.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists labels for issues in a milestone.</p>"
|
||||
}
|
||||
],
|
||||
"milestones": [
|
||||
@@ -338485,13 +338489,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>Response - list of custom role names</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -355659,13 +355663,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -356359,7 +356363,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This will trigger a <a href=\"https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event\">ping event</a>\nto be sent to the hook.</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -356369,7 +356372,8 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>This will trigger a <a href=\"https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event\">ping event</a>\nto be sent to the hook.</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -360728,13 +360732,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -370346,7 +370350,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets information about a GitHub Enterprise Server Pages site.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -370356,7 +370359,8 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets information about a GitHub Enterprise Server Pages site.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -384029,7 +384033,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists pull requests in a specified repository.</p>\n<p>Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a>\nin the GitHub Help documentation.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -384043,7 +384046,8 @@
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists pull requests in a specified repository.</p>\n<p>Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a>\nin the GitHub Help documentation.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -399673,13 +399677,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits\">List commits</a>\nendpoint.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits\">List commits</a>\nendpoint.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -403012,13 +403016,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -425141,7 +425145,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -425155,7 +425158,8 @@
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -435182,13 +435186,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists repositories for the specified organization.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIn order to see the <code>security_and_analysis</code> block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists repositories for the specified organization.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIn order to see the <code>security_and_analysis</code> block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n</div>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -465824,13 +465828,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -476124,13 +476128,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Disables Git LFS for a repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Disables Git LFS for a repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
}
|
||||
],
|
||||
"rule-suites": [
|
||||
@@ -520041,13 +520045,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Delete a discussion from a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Delete a discussion from a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -522535,13 +522539,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists a connection between a team and an external group.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists a connection between a team and an external group.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -523420,7 +523424,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.</p>\n<p>Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/\">Synchronizing teams between your identity provider and GitHub Enterprise Server</a>.\"</p>\n</div>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}</code>.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -523430,7 +523433,8 @@
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden if team synchronization is set up</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.</p>\n<p>Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/\">Synchronizing teams between your identity provider and GitHub Enterprise Server</a>.\"</p>\n</div>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}</code>.</p>\n</div>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -533717,13 +533721,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the SSH signing keys for a user. This operation is accessible by anyone.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the SSH signing keys for a user. This operation is accessible by anyone.</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1152,13 +1152,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the GitHub Actions cache usage policy for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Sets the GitHub Actions cache usage policy for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -8117,13 +8117,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -13243,13 +13243,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -23668,13 +23668,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in a repository.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in a repository.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -26737,13 +26737,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -74261,13 +74261,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -78061,13 +78061,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
|
||||
}
|
||||
],
|
||||
"feeds": [
|
||||
@@ -78406,13 +78406,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>"
|
||||
}
|
||||
],
|
||||
"notifications": [
|
||||
@@ -94548,7 +94548,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -94558,7 +94557,8 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -138160,13 +138160,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a single check run using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a single check run using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -158952,6 +158952,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
@@ -201378,13 +201382,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -201639,13 +201643,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the message and expiration time for the global announcement banner in your enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Sets the message and expiration time for the global announcement banner in your enterprise.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -206918,7 +206922,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Check your installation's maintenance status:</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -206928,7 +206931,8 @@
|
||||
"httpStatusCode": "401",
|
||||
"description": "<p>Unauthorized</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Check your installation's maintenance status:</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME",
|
||||
@@ -425588,7 +425592,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -425598,7 +425601,8 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -468955,13 +468959,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists public repositories for the specified user.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists public repositories for the specified user.</p>"
|
||||
}
|
||||
],
|
||||
"autolinks": [
|
||||
@@ -489322,13 +489326,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -517022,13 +517026,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n</div>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n</div>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
|
||||
@@ -159644,6 +159644,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
|
||||
@@ -553,13 +553,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -2168,13 +2168,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>A JSON serialized template for OIDC subject claim customization</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -4867,13 +4867,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -5375,13 +5375,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.</p>\n<p>If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.</p>\n<p>If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -9432,13 +9432,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -24719,13 +24719,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -25062,13 +25062,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -29296,13 +29296,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
}
|
||||
],
|
||||
"workflow-runs": [
|
||||
@@ -35486,13 +35486,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -66882,13 +66882,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This is the user's organization dashboard. You must be authenticated as the user to view this.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>This is the user's organization dashboard. You must be authenticated as the user to view this.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -159879,6 +159879,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
@@ -193560,13 +193564,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -193967,13 +193971,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -196822,13 +196826,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -197198,13 +197202,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -203703,13 +203707,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment.</p>\n<p>The authenticated user must have admin or owner permissions to the repository to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/apps/apps#get-an-app\">GET an app</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>A list of custom deployment rule integrations available for this environment.</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment.</p>\n<p>The authenticated user must have admin or owner permissions to the repository to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/apps/apps#get-an-app\">GET an app</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -212339,13 +212343,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -225991,13 +225995,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.16/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.16/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -320965,7 +320969,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -320975,7 +320978,8 @@
|
||||
"httpStatusCode": "304",
|
||||
"description": "<p>Not modified</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -353343,13 +353347,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -354150,13 +354154,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -355178,13 +355182,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List all users who are outside collaborators of an organization.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>List all users who are outside collaborators of an organization.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -367944,13 +367948,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -382405,13 +382409,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific package version for a public package owned by a specified user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific package version for a public package owned by a specified user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -384186,13 +384190,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets information about the single most recent build of a GitHub Enterprise Server Pages site.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets information about the single most recent build of a GitHub Enterprise Server Pages site.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -466087,13 +466091,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/articles/about-security-alerts-for-vulnerable-dependencies\">About security alerts for vulnerable dependencies</a>\".</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/articles/about-security-alerts-for-vulnerable-dependencies\">About security alerts for vulnerable dependencies</a>\".</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -499778,13 +499782,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -533111,13 +533115,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussion-comments#create-a-discussion-comment\">Create a discussion comment</a> endpoint.</p>\n</div>\n<p>Creates a new comment on a team discussion.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.16/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussion-comments#create-a-discussion-comment\">Create a discussion comment</a> endpoint.</p>\n</div>\n<p>Creates a new comment on a team discussion.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.16/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -533983,13 +533987,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussion-comments#update-a-discussion-comment\">Update a discussion comment</a> endpoint.</p>\n</div>\n<p>Edits the body text of a discussion comment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussion-comments#update-a-discussion-comment\">Update a discussion comment</a> endpoint.</p>\n</div>\n<p>Edits the body text of a discussion comment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -535050,13 +535054,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.16/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.16/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -538871,13 +538875,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes a connection between a team and an external group.</p>\n<p>You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes a connection between a team and an external group.</p>\n<p>You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
|
||||
}
|
||||
],
|
||||
"members": [
|
||||
|
||||
@@ -264,13 +264,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all artifacts for a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all artifacts for a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -1000,13 +1000,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -1228,13 +1228,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -1554,13 +1554,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets GitHub Actions cache usage policy for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets GitHub Actions cache usage policy for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -2555,13 +2555,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -5636,13 +5636,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-a-repository\">Set GitHub Actions permissions for a repository</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> repository permission to use this API.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-a-repository\">Set GitHub Actions permissions for a repository</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> repository permission to use this API.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -6431,6 +6431,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -6440,8 +6441,7 @@
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>Response when updating a secret</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -7507,13 +7507,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -10618,13 +10618,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -10688,13 +10688,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -12820,13 +12820,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -13217,13 +13217,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an organization runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an organization runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -13365,13 +13365,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
}
|
||||
],
|
||||
"self-hosted-runners": [
|
||||
@@ -16258,13 +16258,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -17269,13 +17269,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -26158,6 +26158,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all repositories that can access an organization variable\nthat is available to selected repositories.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -26167,8 +26168,7 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all repositories that can access an organization variable\nthat is available to selected repositories.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -27265,13 +27265,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all environment variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all environment variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -35197,13 +35197,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes a specific workflow run.</p>\n<p>Anyone with write access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes a specific workflow run.</p>\n<p>Anyone with write access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -38549,7 +38549,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Cancels a workflow run using its <code>id</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "202",
|
||||
@@ -38559,7 +38558,8 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Conflict</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Cancels a workflow run using its <code>id</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -44059,13 +44059,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -59388,13 +59388,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -103901,13 +103901,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -108746,13 +108746,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"<a href=\"/developers/apps/creating-a-github-app\">Creating a GitHub App</a>.\"</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"<a href=\"/developers/apps/creating-a-github-app\">Creating a GitHub App</a>.\"</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -160174,6 +160174,10 @@
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Response if there is already a validation run in progress with a different default setup configuration</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Response if the configuration change cannot be made because the repository is not in the required state</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "503",
|
||||
"description": "<p>Service unavailable</p>"
|
||||
@@ -167315,6 +167319,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the repositories associated with a code security configuration in an organization.</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -167328,8 +167333,7 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the repositories associated with a code security configuration in an organization.</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -184173,7 +184177,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the contents of a specified commit comment.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -184183,7 +184186,8 @@
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the contents of a specified commit comment.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -195736,13 +195740,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -204134,13 +204138,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>List of deployment protection rules</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -209690,13 +209694,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -209753,13 +209757,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -210146,13 +210150,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -210331,13 +210335,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
]
|
||||
}
|
||||
],
|
||||
"announcement": [
|
||||
@@ -210418,13 +210422,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the current message and expiration date of the global announcement banner in your enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the current message and expiration date of the global announcement banner in your enterprise.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -212291,13 +212295,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes an existing audit log stream configuration for an enterprise.</p>\n<p>When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"<a href=\"/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>The audit log stream configuration was deleted successfully.</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes an existing audit log stream configuration for an enterprise.</p>\n<p>When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"<a href=\"/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>"
|
||||
]
|
||||
}
|
||||
],
|
||||
"billing": [
|
||||
@@ -213667,13 +213671,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.17/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.17/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -214247,13 +214251,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Note that this API call does not automatically initiate an LDAP sync. Rather, if a <code>201</code> is returned, the sync job is queued successfully, and is performed when the instance is ready.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Note that this API call does not automatically initiate an LDAP sync. Rather, if a <code>201</code> is returned, the sync job is queued successfully, and is performed when the instance is ready.</p>"
|
||||
}
|
||||
],
|
||||
"license": [
|
||||
@@ -214332,13 +214336,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"manage-ghes": [
|
||||
@@ -217164,13 +217168,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -217546,13 +217550,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -218409,13 +218413,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>In addition to seeing the download status at the \"<a href=\"#get-a-pre-receive-environment\">Get a pre-receive environment</a>\" endpoint, there is also this separate endpoint for just the download status.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>In addition to seeing the download status at the \"<a href=\"#get-a-pre-receive-environment\">Get a pre-receive environment</a>\" endpoint, there is also this separate endpoint for just the download status.</p>"
|
||||
}
|
||||
],
|
||||
"pre-receive-hooks": [
|
||||
@@ -218621,13 +218625,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -219719,13 +219723,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes any overridden enforcement on this repository for the specified hook.</p>\n<p>Responds with effective values inherited from owner and/or global level.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>Responds with effective values inherited from owner and/or global level.</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes any overridden enforcement on this repository for the specified hook.</p>\n<p>Responds with effective values inherited from owner and/or global level.</p>"
|
||||
]
|
||||
}
|
||||
],
|
||||
"scim": [
|
||||
@@ -325395,13 +325399,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -342613,6 +342617,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.17/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -342622,8 +342627,7 @@
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.17/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.17/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -350098,13 +350102,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
|
||||
}
|
||||
],
|
||||
"members": [
|
||||
@@ -354726,13 +354730,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -355533,13 +355537,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -356737,7 +356741,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Removing a user from this list will remove them from all the organization's repositories.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -356747,7 +356750,8 @@
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Unprocessable Entity if user is a member of the organization</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Removing a user from this list will remove them from all the organization's repositories.</p>"
|
||||
}
|
||||
],
|
||||
"personal-access-tokens": [
|
||||
@@ -370299,13 +370303,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -375440,13 +375444,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -420387,13 +420391,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/pulls/reviews#list-reviews-for-a-pull-request\">List reviews for a pull request</a> operation.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the <a href=\"https://docs.github.com/enterprise-server@3.17/rest/pulls/reviews#list-reviews-for-a-pull-request\">List reviews for a pull request</a> operation.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -434563,13 +434567,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -466342,13 +466346,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -487847,7 +487851,6 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -487857,7 +487860,8 @@
|
||||
"httpStatusCode": "400",
|
||||
"description": "<p>Bad Request</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -504251,13 +504255,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -526076,13 +526080,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -538504,13 +538508,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/discussion-comments#list-discussion-comments\">List discussion comments</a> endpoint.</p>\n</div>\n<p>List all comments on a team discussion.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/discussion-comments#list-discussion-comments\">List discussion comments</a> endpoint.</p>\n</div>\n<p>List all comments on a team discussion.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -541904,13 +541908,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Delete a discussion from a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Delete a discussion from a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -543821,13 +543825,13 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/discussions#update-a-discussion\">Update a discussion</a> endpoint.</p>\n</div>\n<p>Edits the title and body text of a discussion post. Only the parameters you provide are updated.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
],
|
||||
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.17/rest/teams/discussions#update-a-discussion\">Update a discussion</a> endpoint.</p>\n</div>\n<p>Edits the title and body text of a discussion post. Only the parameters you provide are updated.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
|
||||
@@ -47,5 +47,5 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"sha": "527d41e4237d9ad0bac93932fe1d2fb22f8d1b97"
|
||||
"sha": "664cf25da36ebb8f97693e51663addaed26bbae5"
|
||||
}
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"sha": "527d41e4237d9ad0bac93932fe1d2fb22f8d1b97"
|
||||
"sha": "664cf25da36ebb8f97693e51663addaed26bbae5"
|
||||
}
|
||||
Reference in New Issue
Block a user